home *** CD-ROM | disk | FTP | other *** search
/ PCGUIA 127 / PC Guia 127.iso / Software / Produtividade / OpenOffice.org 2.0.1 / openofficeorg3.cab / asyncore.py < prev    next >
Text File  |  2005-11-19  |  17KB  |  552 lines
  1. # -*- Mode: Python -*-
  2. #   Id: asyncore.py,v 2.51 2000/09/07 22:29:26 rushing Exp
  3. #   Author: Sam Rushing <rushing@nightmare.com>
  4.  
  5. # ======================================================================
  6. # Copyright 1996 by Sam Rushing
  7. #
  8. #                         All Rights Reserved
  9. #
  10. # Permission to use, copy, modify, and distribute this software and
  11. # its documentation for any purpose and without fee is hereby
  12. # granted, provided that the above copyright notice appear in all
  13. # copies and that both that copyright notice and this permission
  14. # notice appear in supporting documentation, and that the name of Sam
  15. # Rushing not be used in advertising or publicity pertaining to
  16. # distribution of the software without specific, written prior
  17. # permission.
  18. #
  19. # SAM RUSHING DISCLAIMS ALL WARRANTIES WITH REGARD TO THIS SOFTWARE,
  20. # INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS, IN
  21. # NO EVENT SHALL SAM RUSHING BE LIABLE FOR ANY SPECIAL, INDIRECT OR
  22. # CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS
  23. # OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT,
  24. # NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN
  25. # CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
  26. # ======================================================================
  27.  
  28. """Basic infrastructure for asynchronous socket service clients and servers.
  29.  
  30. There are only two ways to have a program on a single processor do "more
  31. than one thing at a time".  Multi-threaded programming is the simplest and
  32. most popular way to do it, but there is another very different technique,
  33. that lets you have nearly all the advantages of multi-threading, without
  34. actually using multiple threads. it's really only practical if your program
  35. is largely I/O bound. If your program is CPU bound, then pre-emptive
  36. scheduled threads are probably what you really need. Network servers are
  37. rarely CPU-bound, however.
  38.  
  39. If your operating system supports the select() system call in its I/O
  40. library (and nearly all do), then you can use it to juggle multiple
  41. communication channels at once; doing other work while your I/O is taking
  42. place in the "background."  Although this strategy can seem strange and
  43. complex, especially at first, it is in many ways easier to understand and
  44. control than multi-threaded programming. The module documented here solves
  45. many of the difficult problems for you, making the task of building
  46. sophisticated high-performance network servers and clients a snap.
  47. """
  48.  
  49. import exceptions
  50. import select
  51. import socket
  52. import sys
  53. import time
  54.  
  55. import os
  56. from errno import EALREADY, EINPROGRESS, EWOULDBLOCK, ECONNRESET, \
  57.      ENOTCONN, ESHUTDOWN, EINTR, EISCONN
  58.  
  59. try:
  60.     socket_map
  61. except NameError:
  62.     socket_map = {}
  63.  
  64. class ExitNow(exceptions.Exception):
  65.     pass
  66.  
  67. def read(obj):
  68.     try:
  69.         obj.handle_read_event()
  70.     except ExitNow:
  71.         raise
  72.     except:
  73.         obj.handle_error()
  74.  
  75. def write(obj):
  76.     try:
  77.         obj.handle_write_event()
  78.     except ExitNow:
  79.         raise
  80.     except:
  81.         obj.handle_error()
  82.  
  83. def readwrite(obj, flags):
  84.     try:
  85.         if flags & select.POLLIN:
  86.             obj.handle_read_event()
  87.         if flags & select.POLLOUT:
  88.             obj.handle_write_event()
  89.     except ExitNow:
  90.         raise
  91.     except:
  92.         obj.handle_error()
  93.  
  94. def poll(timeout=0.0, map=None):
  95.     if map is None:
  96.         map = socket_map
  97.     if map:
  98.         r = []; w = []; e = []
  99.         for fd, obj in map.items():
  100.             if obj.readable():
  101.                 r.append(fd)
  102.             if obj.writable():
  103.                 w.append(fd)
  104.         if [] == r == w == e:
  105.             time.sleep(timeout)
  106.         else:
  107.             try:
  108.                 r, w, e = select.select(r, w, e, timeout)
  109.             except select.error, err:
  110.                 if err[0] != EINTR:
  111.                     raise
  112.                 else:
  113.                     return
  114.  
  115.         for fd in r:
  116.             obj = map.get(fd)
  117.             if obj is None:
  118.                 continue
  119.             read(obj)
  120.  
  121.         for fd in w:
  122.             obj = map.get(fd)
  123.             if obj is None:
  124.                 continue
  125.             write(obj)
  126.  
  127. def poll2(timeout=0.0, map=None):
  128.     import poll
  129.     if map is None:
  130.         map = socket_map
  131.     if timeout is not None:
  132.         # timeout is in milliseconds
  133.         timeout = int(timeout*1000)
  134.     if map:
  135.         l = []
  136.         for fd, obj in map.items():
  137.             flags = 0
  138.             if obj.readable():
  139.                 flags = poll.POLLIN
  140.             if obj.writable():
  141.                 flags = flags | poll.POLLOUT
  142.             if flags:
  143.                 l.append((fd, flags))
  144.         r = poll.poll(l, timeout)
  145.         for fd, flags in r:
  146.             obj = map.get(fd)
  147.             if obj is None:
  148.                 continue
  149.             readwrite(obj, flags)
  150.  
  151. def poll3(timeout=0.0, map=None):
  152.     # Use the poll() support added to the select module in Python 2.0
  153.     if map is None:
  154.         map = socket_map
  155.     if timeout is not None:
  156.         # timeout is in milliseconds
  157.         timeout = int(timeout*1000)
  158.     pollster = select.poll()
  159.     if map:
  160.         for fd, obj in map.items():
  161.             flags = 0
  162.             if obj.readable():
  163.                 flags = select.POLLIN
  164.             if obj.writable():
  165.                 flags = flags | select.POLLOUT
  166.             if flags:
  167.                 pollster.register(fd, flags)
  168.         try:
  169.             r = pollster.poll(timeout)
  170.         except select.error, err:
  171.             if err[0] != EINTR:
  172.                 raise
  173.             r = []
  174.         for fd, flags in r:
  175.             obj = map.get(fd)
  176.             if obj is None:
  177.                 continue
  178.             readwrite(obj, flags)
  179.  
  180. def loop(timeout=30.0, use_poll=0, map=None):
  181.     if map is None:
  182.         map = socket_map
  183.  
  184.     if use_poll:
  185.         if hasattr(select, 'poll'):
  186.             poll_fun = poll3
  187.         else:
  188.             poll_fun = poll2
  189.     else:
  190.         poll_fun = poll
  191.  
  192.     while map:
  193.         poll_fun(timeout, map)
  194.  
  195. class dispatcher:
  196.  
  197.     debug = 0
  198.     connected = 0
  199.     accepting = 0
  200.     closing = 0
  201.     addr = None
  202.  
  203.     def __init__(self, sock=None, map=None):
  204.         if sock:
  205.             self.set_socket(sock, map)
  206.             # I think it should inherit this anyway
  207.             self.socket.setblocking(0)
  208.             self.connected = 1
  209.             # XXX Does the constructor require that the socket passed
  210.             # be connected?
  211.             try:
  212.                 self.addr = sock.getpeername()
  213.             except socket.error:
  214.                 # The addr isn't crucial
  215.                 pass
  216.         else:
  217.             self.socket = None
  218.  
  219.     def __repr__(self):
  220.         status = [self.__class__.__module__+"."+self.__class__.__name__]
  221.         if self.accepting and self.addr:
  222.             status.append('listening')
  223.         elif self.connected:
  224.             status.append('connected')
  225.         if self.addr is not None:
  226.             try:
  227.                 status.append('%s:%d' % self.addr)
  228.             except TypeError:
  229.                 status.append(repr(self.addr))
  230.         # On some systems (RH10) id() can be a negative number. 
  231.         # work around this.
  232.         MAX = 2L*sys.maxint+1
  233.         return '<%s at %#x>' % (' '.join(status), id(self)&MAX)
  234.  
  235.     def add_channel(self, map=None):
  236.         #self.log_info('adding channel %s' % self)
  237.         if map is None:
  238.             map = socket_map
  239.         map[self._fileno] = self
  240.  
  241.     def del_channel(self, map=None):
  242.         fd = self._fileno
  243.         if map is None:
  244.             map = socket_map
  245.         if map.has_key(fd):
  246.             #self.log_info('closing channel %d:%s' % (fd, self))
  247.             del map[fd]
  248.  
  249.     def create_socket(self, family, type):
  250.         self.family_and_type = family, type
  251.         self.socket = socket.socket(family, type)
  252.         self.socket.setblocking(0)
  253.         self._fileno = self.socket.fileno()
  254.         self.add_channel()
  255.  
  256.     def set_socket(self, sock, map=None):
  257.         self.socket = sock
  258. ##        self.__dict__['socket'] = sock
  259.         self._fileno = sock.fileno()
  260.         self.add_channel(map)
  261.  
  262.     def set_reuse_addr(self):
  263.         # try to re-use a server port if possible
  264.         try:
  265.             self.socket.setsockopt(
  266.                 socket.SOL_SOCKET, socket.SO_REUSEADDR,
  267.                 self.socket.getsockopt(socket.SOL_SOCKET,
  268.                                        socket.SO_REUSEADDR) | 1
  269.                 )
  270.         except socket.error:
  271.             pass
  272.  
  273.     # ==================================================
  274.     # predicates for select()
  275.     # these are used as filters for the lists of sockets
  276.     # to pass to select().
  277.     # ==================================================
  278.  
  279.     def readable(self):
  280.         return True
  281.  
  282.     if os.name == 'mac':
  283.         # The macintosh will select a listening socket for
  284.         # write if you let it.  What might this mean?
  285.         def writable(self):
  286.             return not self.accepting
  287.     else:
  288.         def writable(self):
  289.             return True
  290.  
  291.     # ==================================================
  292.     # socket object methods.
  293.     # ==================================================
  294.  
  295.     def listen(self, num):
  296.         self.accepting = 1
  297.         if os.name == 'nt' and num > 5:
  298.             num = 1
  299.         return self.socket.listen(num)
  300.  
  301.     def bind(self, addr):
  302.         self.addr = addr
  303.         return self.socket.bind(addr)
  304.  
  305.     def connect(self, address):
  306.         self.connected = 0
  307.         err = self.socket.connect_ex(address)
  308.         # XXX Should interpret Winsock return values
  309.         if err in (EINPROGRESS, EALREADY, EWOULDBLOCK):
  310.             return
  311.         if err in (0, EISCONN):
  312.             self.addr = address
  313.             self.connected = 1
  314.             self.handle_connect()
  315.         else:
  316.             raise socket.error, err
  317.  
  318.     def accept(self):
  319.         # XXX can return either an address pair or None
  320.         try:
  321.             conn, addr = self.socket.accept()
  322.             return conn, addr
  323.         except socket.error, why:
  324.             if why[0] == EWOULDBLOCK:
  325.                 pass
  326.             else:
  327.                 raise socket.error, why
  328.  
  329.     def send(self, data):
  330.         try:
  331.             result = self.socket.send(data)
  332.             return result
  333.         except socket.error, why:
  334.             if why[0] == EWOULDBLOCK:
  335.                 return 0
  336.             else:
  337.                 raise socket.error, why
  338.             return 0
  339.  
  340.     def recv(self, buffer_size):
  341.         try:
  342.             data = self.socket.recv(buffer_size)
  343.             if not data:
  344.                 # a closed connection is indicated by signaling
  345.                 # a read condition, and having recv() return 0.
  346.                 self.handle_close()
  347.                 return ''
  348.             else:
  349.                 return data
  350.         except socket.error, why:
  351.             # winsock sometimes throws ENOTCONN
  352.             if why[0] in [ECONNRESET, ENOTCONN, ESHUTDOWN]:
  353.                 self.handle_close()
  354.                 return ''
  355.             else:
  356.                 raise socket.error, why
  357.  
  358.     def close(self):
  359.         self.del_channel()
  360.         self.socket.close()
  361.  
  362.     # cheap inheritance, used to pass all other attribute
  363.     # references to the underlying socket object.
  364.     def __getattr__(self, attr):
  365.         return getattr(self.socket, attr)
  366.  
  367.     # log and log_info may be overridden to provide more sophisticated
  368.     # logging and warning methods. In general, log is for 'hit' logging
  369.     # and 'log_info' is for informational, warning and error logging.
  370.  
  371.     def log(self, message):
  372.         sys.stderr.write('log: %s\n' % str(message))
  373.  
  374.     def log_info(self, message, type='info'):
  375.         if __debug__ or type != 'info':
  376.             print '%s: %s' % (type, message)
  377.  
  378.     def handle_read_event(self):
  379.         if self.accepting:
  380.             # for an accepting socket, getting a read implies
  381.             # that we are connected
  382.             if not self.connected:
  383.                 self.connected = 1
  384.             self.handle_accept()
  385.         elif not self.connected:
  386.             self.handle_connect()
  387.             self.connected = 1
  388.             self.handle_read()
  389.         else:
  390.             self.handle_read()
  391.  
  392.     def handle_write_event(self):
  393.         # getting a write implies that we are connected
  394.         if not self.connected:
  395.             self.handle_connect()
  396.             self.connected = 1
  397.         self.handle_write()
  398.  
  399.     def handle_expt_event(self):
  400.         self.handle_expt()
  401.  
  402.     def handle_error(self):
  403.         nil, t, v, tbinfo = compact_traceback()
  404.  
  405.         # sometimes a user repr method will crash.
  406.         try:
  407.             self_repr = repr(self)
  408.         except:
  409.             self_repr = '<__repr__(self) failed for object at %0x>' % id(self)
  410.  
  411.         self.log_info(
  412.             'uncaptured python exception, closing channel %s (%s:%s %s)' % (
  413.                 self_repr,
  414.                 t,
  415.                 v,
  416.                 tbinfo
  417.                 ),
  418.             'error'
  419.             )
  420.         self.close()
  421.  
  422.     def handle_expt(self):
  423.         self.log_info('unhandled exception', 'warning')
  424.  
  425.     def handle_read(self):
  426.         self.log_info('unhandled read event', 'warning')
  427.  
  428.     def handle_write(self):
  429.         self.log_info('unhandled write event', 'warning')
  430.  
  431.     def handle_connect(self):
  432.         self.log_info('unhandled connect event', 'warning')
  433.  
  434.     def handle_accept(self):
  435.         self.log_info('unhandled accept event', 'warning')
  436.  
  437.     def handle_close(self):
  438.         self.log_info('unhandled close event', 'warning')
  439.         self.close()
  440.  
  441. # ---------------------------------------------------------------------------
  442. # adds simple buffered output capability, useful for simple clients.
  443. # [for more sophisticated usage use asynchat.async_chat]
  444. # ---------------------------------------------------------------------------
  445.  
  446. class dispatcher_with_send(dispatcher):
  447.  
  448.     def __init__(self, sock=None):
  449.         dispatcher.__init__(self, sock)
  450.         self.out_buffer = ''
  451.  
  452.     def initiate_send(self):
  453.         num_sent = 0
  454.         num_sent = dispatcher.send(self, self.out_buffer[:512])
  455.         self.out_buffer = self.out_buffer[num_sent:]
  456.  
  457.     def handle_write(self):
  458.         self.initiate_send()
  459.  
  460.     def writable(self):
  461.         return (not self.connected) or len(self.out_buffer)
  462.  
  463.     def send(self, data):
  464.         if self.debug:
  465.             self.log_info('sending %s' % repr(data))
  466.         self.out_buffer = self.out_buffer + data
  467.         self.initiate_send()
  468.  
  469. # ---------------------------------------------------------------------------
  470. # used for debugging.
  471. # ---------------------------------------------------------------------------
  472.  
  473. def compact_traceback():
  474.     t, v, tb = sys.exc_info()
  475.     tbinfo = []
  476.     assert tb # Must have a traceback
  477.     while tb:
  478.         tbinfo.append((
  479.             tb.tb_frame.f_code.co_filename,
  480.             tb.tb_frame.f_code.co_name,
  481.             str(tb.tb_lineno)
  482.             ))
  483.         tb = tb.tb_next
  484.  
  485.     # just to be safe
  486.     del tb
  487.  
  488.     file, function, line = tbinfo[-1]
  489.     info = ' '.join(['[%s|%s|%s]' % x for x in tbinfo])
  490.     return (file, function, line), t, v, info
  491.  
  492. def close_all(map=None):
  493.     if map is None:
  494.         map = socket_map
  495.     for x in map.values():
  496.         x.socket.close()
  497.     map.clear()
  498.  
  499. # Asynchronous File I/O:
  500. #
  501. # After a little research (reading man pages on various unixen, and
  502. # digging through the linux kernel), I've determined that select()
  503. # isn't meant for doing asynchronous file i/o.
  504. # Heartening, though - reading linux/mm/filemap.c shows that linux
  505. # supports asynchronous read-ahead.  So _MOST_ of the time, the data
  506. # will be sitting in memory for us already when we go to read it.
  507. #
  508. # What other OS's (besides NT) support async file i/o?  [VMS?]
  509. #
  510. # Regardless, this is useful for pipes, and stdin/stdout...
  511.  
  512. if os.name == 'posix':
  513.     import fcntl
  514.  
  515.     class file_wrapper:
  516.         # here we override just enough to make a file
  517.         # look like a socket for the purposes of asyncore.
  518.  
  519.         def __init__(self, fd):
  520.             self.fd = fd
  521.  
  522.         def recv(self, *args):
  523.             return os.read(self.fd, *args)
  524.  
  525.         def send(self, *args):
  526.             return os.write(self.fd, *args)
  527.  
  528.         read = recv
  529.         write = send
  530.  
  531.         def close(self):
  532.             return os.close(self.fd)
  533.  
  534.         def fileno(self):
  535.             return self.fd
  536.  
  537.     class file_dispatcher(dispatcher):
  538.  
  539.         def __init__(self, fd):
  540.             dispatcher.__init__(self)
  541.             self.connected = 1
  542.             # set it to non-blocking mode
  543.             flags = fcntl.fcntl(fd, fcntl.F_GETFL, 0)
  544.             flags = flags | os.O_NONBLOCK
  545.             fcntl.fcntl(fd, fcntl.F_SETFL, flags)
  546.             self.set_file(fd)
  547.  
  548.         def set_file(self, fd):
  549.             self._fileno = fd
  550.             self.socket = file_wrapper(fd)
  551.             self.add_channel()
  552.